feat: Property filter enum tokens #2739

pan-kot · 2024-09-19T14:14:26Z

Description

Adds first-class support for multi-choice (enum) tokens in property filter.

Rel: [Tz3OAr3i2ni1], [0aVwAjMOimcN]

Depends on:

How has this been tested?

New unit tests
Screenshot tests

Review checklist

The following items are to be evaluated by the author(s) and the reviewer(s).

Correctness

Changes include appropriate documentation updates.
Changes are backward-compatible if not indicated, see CONTRIBUTING.md.
Changes do not include unsupported browser features, see CONTRIBUTING.md.
Changes were manually tested for accessibility, see accessibility guidelines.

Security

If the code handles URLs: all URLs are validated through the checkSafeUrl function.

Testing

Changes are covered with new/existing unit tests?
Changes are covered with new/existing integration tests?

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov · 2024-09-19T14:23:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.22%. Comparing base (cc75463) to head (dd8a730).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2739   +/-   ##
=======================================
  Coverage   96.21%   96.22%           
=======================================
  Files         761      761           
  Lines       21502    21556   +54     
  Branches     7354     7326   -28     
=======================================
+ Hits        20688    20742   +54     
+ Misses        806      761   -45     
- Partials        8       53   +45

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pan-kot · 2024-10-17T09:27:00Z

src/button-dropdown/internal.tsx

@@ -230,9 +230,7 @@ const InternalButtonDropdown = React.forwardRef(
          {text}
        </InternalButton>
      );
-      trigger = showMainActionOnly ? (


This change is needed so that onKeyDown and onKeyUp handlers are attached that prevent Enter keypress propagation. Without that, the main action cannot be activated with Enter.

The listeners are attached to the outer div instead of the button dropdown? Why?

I am not 100% sure, but I think that is because those should work for both the trigger and the dropdown: if the listeners are added to the button dropdown trigger alone, that might change the current behaviour. I can experiment with that but in a standalone PR.

Is this fixing an existing bug? If so, can we add coverage for the fix? I'd be OK with having this in a separate PR (actually even better).

Created a separate PR: #2897

I also created a separate one for embedded multiselect fixes: #2896

src/multiselect/embedded.tsx

pages/property-filter/common-props.tsx

src/multiselect/embedded.tsx

jperals · 2024-10-17T11:56:56Z

src/button-dropdown/internal.tsx

@@ -230,9 +230,7 @@ const InternalButtonDropdown = React.forwardRef(
          {text}
        </InternalButton>
      );
-      trigger = showMainActionOnly ? (


The listeners are attached to the outer div instead of the button dropdown? Why?

jperals · 2024-10-18T13:07:01Z

src/__tests__/__snapshots__/documenter.test.ts.snap

@@ -12636,7 +12636,7 @@ The \`operation\` property has two valid values: "and", "or", and controls the j
 The \`tokens\` property is an array of objects that will be displayed to the user beneath the filtering input. When \`enableTokenGroups=true\`, the
 \`tokenGroups\` property is used instead, which supports nested tokens.
 Each token has the following properties:
-* value [string]: The string value of the token to be used as a filter.
+* value [unknown]: The value of the token to be used as a filter. Can be null or string for default tokens, string[] for enum tokens, and anything for tokens with custom forms.


Just to double-check that this API change is OK (the doc text update suggests yes), and this will not cause issues to existing customers (do we want to run a dry run?)

I did make a dry-run for the type update in collection hooks. In this PR no type was updated, but will do a dry-run as well, just in case.

The value has been essentially unknown since introduction of custom forms. The current PR should have no impact to the existing customers but those making something with the query and wanting to adopt the feature would need to ensure the type is correctly handled at runtime.

jperals · 2024-10-18T13:24:50Z

src/property-filter/__tests__/property-filter-enum-tokens.test.tsx

+  };
+};
+
+test('formats tokens using custom and default formatters', () => {


What do we mean by "custom and default formatters"? Are we indeed testing both?

By default, the enum tokens are formatted as value.join(', '). It is also possible to provide a custom format function. In the test page this is done for State and Tags properties, in one case to translate options and in another case to truncate long values, if more than 5 options are selected.

pan-kot force-pushed the feat-property-filter-enum-props branch 3 times, most recently from 9e32565 to ec57f06 Compare September 20, 2024 08:28

pan-kot changed the title ~~poc: Property filter enum props POC~~ chore: Property filter enum props POC Sep 20, 2024

pan-kot force-pushed the feat-property-filter-enum-props branch from ec57f06 to af7c2bf Compare September 20, 2024 12:16

pan-kot deployed to dev-pages September 20, 2024 12:24 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from af7c2bf to 128fbd4 Compare September 24, 2024 10:18

pan-kot deployed to dev-pages September 24, 2024 10:26 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from 128fbd4 to 9853c8a Compare October 7, 2024 12:27

pan-kot deployed to dev-pages October 7, 2024 12:35 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from 9853c8a to 085c7b9 Compare October 7, 2024 13:12

pan-kot deployed to dev-pages October 7, 2024 13:20 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch 3 times, most recently from f592e4f to d16f901 Compare October 8, 2024 16:00

pan-kot deployed to dev-pages October 8, 2024 16:08 — with GitHub Actions View deployment

pan-kot mentioned this pull request Oct 9, 2024

chore: Property filter custom form header improvement #2835

Merged

pan-kot force-pushed the feat-property-filter-enum-props branch from d16f901 to 3d8604c Compare October 9, 2024 16:52

pan-kot deployed to dev-pages October 9, 2024 17:00 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from 3d8604c to 680473e Compare October 10, 2024 08:14

pan-kot deployed to dev-pages October 10, 2024 08:22 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch 2 times, most recently from 9b9c3dd to a8f6987 Compare October 10, 2024 11:06

pan-kot mentioned this pull request Oct 10, 2024

feat: Adds property filter custom form actions test utils selectors #2840

Merged

pan-kot force-pushed the feat-property-filter-enum-props branch 2 times, most recently from 0fbd924 to 10eff20 Compare October 11, 2024 10:21

pan-kot deployed to dev-pages October 11, 2024 10:30 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from 10eff20 to f0b493a Compare October 11, 2024 11:31

pan-kot deployed to dev-pages October 11, 2024 11:40 — with GitHub Actions View deployment

pan-kot deployed to dev-pages October 13, 2024 10:08 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch 3 times, most recently from ccd4dbb to f0a1159 Compare October 17, 2024 07:35

pan-kot deployed to dev-pages October 17, 2024 07:43 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch 2 times, most recently from dee0e7b to 27195c3 Compare October 17, 2024 09:23

pan-kot commented Oct 17, 2024

View reviewed changes

src/multiselect/embedded.tsx Show resolved Hide resolved

pan-kot deployed to dev-pages October 17, 2024 09:31 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from 27195c3 to 92ef6ba Compare October 17, 2024 09:37

pan-kot changed the title ~~chore: Property filter enum props POC~~ feat: Property filter enum tokens Oct 17, 2024

pan-kot marked this pull request as ready for review October 17, 2024 09:41

pan-kot requested a review from a team as a code owner October 17, 2024 09:41

pan-kot requested review from jperals and removed request for a team October 17, 2024 09:41

pan-kot deployed to dev-pages October 17, 2024 09:45 — with GitHub Actions View deployment

pan-kot force-pushed the feat-property-filter-enum-props branch from 92ef6ba to 1107f2c Compare October 17, 2024 09:54

pan-kot deployed to dev-pages October 17, 2024 10:02 — with GitHub Actions View deployment

jperals reviewed Oct 17, 2024

View reviewed changes

pan-kot mentioned this pull request Oct 18, 2024

chore: Fixes embedded multiselect focus management #2896

Merged

pan-kot deployed to dev-pages October 18, 2024 08:52 — with GitHub Actions View deployment

pan-kot requested a review from jperals October 18, 2024 12:44

jperals reviewed Oct 18, 2024

View reviewed changes

pan-kot added 2 commits October 18, 2024 15:25

feat: Enum tokens in property filter

e2cdb62

update api docs

dd8a730

pan-kot force-pushed the feat-property-filter-enum-props branch from 114af6e to dd8a730 Compare October 18, 2024 13:25

pan-kot deployed to dev-pages October 18, 2024 13:33 — with GitHub Actions View deployment

pan-kot requested a review from jperals October 18, 2024 15:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Property filter enum tokens #2739

feat: Property filter enum tokens #2739

pan-kot commented Sep 19, 2024 •

edited

Loading

codecov bot commented Sep 19, 2024 •

edited

Loading

pan-kot Oct 17, 2024

jperals Oct 17, 2024

pan-kot Oct 17, 2024

jperals Oct 18, 2024

pan-kot Oct 18, 2024

pan-kot Oct 18, 2024

jperals Oct 17, 2024

jperals Oct 18, 2024

pan-kot Oct 18, 2024

jperals Oct 18, 2024

pan-kot Oct 18, 2024

feat: Property filter enum tokens #2739

Are you sure you want to change the base?

feat: Property filter enum tokens #2739

Conversation

pan-kot commented Sep 19, 2024 • edited Loading

Description

How has this been tested?

Correctness

Security

Testing

codecov bot commented Sep 19, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pan-kot commented Sep 19, 2024 •

edited

Loading

codecov bot commented Sep 19, 2024 •

edited

Loading